home *** CD-ROM | disk | FTP | other *** search
/ The X-Philes (2nd Revision) / The X-Philes Number 1 (1995).iso / xphiles / psion / agenda.fmt < prev    next >
Text File  |  1995-03-31  |  4KB  |  98 lines
  1. PSIONICS FILE - AGENDA.FMT
  2. ==========================
  3. Format of Agenda files
  4. Last modified 1994-01-15
  5. ========================
  6.  
  7. Agenda files are normal database files containing five primary and no secondary
  8. fields; the primary fields are four word fields followed by one qstr field.
  9. The file also contains one segmented record.
  10.  
  11. The segmented record contains one sub-record of type 15. This sub-record
  12. always contains exactly 12 bytes. These are not always the same; the following
  13. examples have been seen:
  14.  
  15.   $E0,$01,$3C,$00,$01,$00,$0F,$00,$1C,$02,$3A,$00  (my main agenda)
  16.   $A4,$01,$3C,$00,$01,$00,$0F,$00,$1C,$02,$2E,$00  (a new database)
  17.  
  18.  
  19. Each data record holds one calendar even (possibly repeating), one day-note
  20. event (possibly repeating), or one to-do item. The record contents for each
  21. of these are described here.
  22.  
  23. Calendar events have the format:
  24.   Field 1 (word): day number of the event
  25.   Field 2 (word): duration of the event in minutes, times 2, plus 1 if there
  26.                   is not an alarm attached
  27.   Field 3 (word): time of the event, in minutes past midnight
  28.   Field 4 (word): time of the alarm in minutes before 23:59 of the day the
  29.                   event occurs on, or $FFFF if there is no alarm
  30.   Field 5 (qstr): item text
  31.  
  32. Repeating calendar events have the format:
  33.   Field 1 (word): $FFFE
  34.   Field 2 (word): duration of the event in minutes, times 2, plus 1 if there
  35.                   is not an alarm attached
  36.   Field 3 (word): time of the event, in minutes past midnight
  37.   Field 4 (word): time of the alarm in minutes before 23:59 of the day the
  38.                   event occurs on, or $FFFF if there is no alarm
  39.   Field 5 (qstr): item text followed by repeat information
  40.  
  41. Day note events have the format:
  42.   Field 1 (word): day number of the event
  43.   Field 2 (word): 0 if an alarm is attached, or 1 if not
  44.   Field 3 (word): position of item in list:
  45.     $8000 = first day item on that date
  46.     $8001 = second day item on that date
  47.     etc.
  48.   Field 4 (word): time of the alarm in minutes before 23:59 of the day the
  49.                   event occurs on, or $FFFF if there is no alarm
  50.   Field 5 (qstr): item text
  51.  
  52. Repeating day note events have the format:
  53.   Field 1 (word): $FFFE
  54.   Field 2 (word): 0 if an alarm is attached, or 1 if not
  55.   Field 3 (word): position of item in list:
  56.     $8000 = first day item on that date
  57.     $8001 = second day item on that date
  58.     etc.
  59.   Field 4 (word): time of the alarm in minutes before 23:59 of the day
  60.   Field 5 (qstr): item text followed by repeat information
  61.  
  62. To-do items have the format:
  63.   Field 1 (word): $FFFF
  64.   Field 2 (word): position of item among those with this priority:
  65.     0 = first item
  66.     2 = second item
  67.     4 = third item
  68.     6 = fourth item
  69.     etc.
  70.   Field 3 (word): item priority (1 to 9 inclusive)
  71.   Field 4 (word): unused
  72.   Field 5 (qstr): item text
  73.  
  74.  
  75. For repeating items, the item text is always followed by a 6 byte block giving
  76. the repeat information (this block is included in the qstr as far as the
  77. database format is concerned). This block has the form:
  78.   Offset  0 (byte): repeat type:
  79.     0 = yearly
  80.     1 = monthly by date
  81.     2 = monthly by day
  82.     3 = weekly
  83.     4 = daily
  84.     5 = workdays
  85.   Offset  1 (byte): repeat interval
  86.   Offset  2 (word): day number of the first occurence
  87.   Offset  4 (word): day number of the last occurence, or 0 if repeats forever
  88.  
  89.  
  90. Day numbers must lie between 29219 and 54786 (years 1980 and 2049) inclusive.
  91. The end of a calendar event must lie in the same day as its start.
  92. -- 
  93. Clive D.W. Feather     | Santa Cruz Operation    | If you lie to the compiler,
  94. clive@sco.com          | Croxley Centre          | it will get its revenge.
  95. Phone: +44 923 816 344 | Hatters Lane, Watford   |   - Henry Spencer
  96. Fax:   +44 923 817 688 | WD1 8YN, United Kingdom |
  97.  
  98.